Documentação - Documentação

get https://billing.iugu.com/api/events/{idempotency_key}

Retorna um único evento baseado na chave de idempotencia fornecida

Permissão necessária: billing:event.show

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
idempotency_key Required Type: string chave de idempotência

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

Se o evento existir

event

Object

Evento retornado

idempotency_key

String

Chave única que impede o envio do evento em duplicidade. É de total responsabilidade do desenvolvedor garantir que as chaves sejam únicas

Ex: 2416b3e0-309d-4c3c-bc96-9b4b118454d5

name

String

Nome do seu evento

Ex: meu.evento

metadata Object Map de chave/valor com informações adicionais do evento enviado Ex: {"transacao"=>1, "valor"=>50}

entity_name

String

Nome da entidade mapeada pelo evento

Ex: Transação

entity_id

String

Id da entidade mapeada pelo evento

Ex: 09e8174e-0117-4382-90c4-32b25bbbc39f

custom_unit_quantity

Number

Quantidade que será contabilizada na cobrança (Caso a precificação seja do tipo customizada)

Ex: 10.23

timestamp

String

Hora do seu evento no formato ISO 8601 em UTC sem offset de fuso horário

Ex: 2024-01-01T01:23:45Z

errors

String

Lista de erros ocorridos.

Ex: ["Event timestamp 2025-05-05T20:50:23+00:00 must be later than 2025-05-06T07:47:03.782125+00:00 based on account grace period. To ingest an event older than the account grace period, create a backfill: https://docs.withorb.com/reference/create-backfill"]

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "event": {
    "idempotency_key": "2416b3e0-309d-4c3c-bc96-9b4b118454d5",
    "name": "meu.evento",
    "metadata": {
      "transacao": 1,
      "valor": 50
    },
    "entity_name": "Transação",
    "entity_id": "09e8174e-0117-4382-90c4-32b25bbbc39f",
    "custom_unit_quantity": 10.23,
    "timestamp": "2024-01-01T01:23:45Z",
    "errors": [
      "Event timestamp 2025-05-05T20:50:23+00:00 must be later than 2025-05-06T07:47:03.782125+00:00 based on account grace period. To ingest an event older than the account grace period, create a backfill: https://docs.withorb.com/reference/create-backfill"
    ]
  }
}

401

Quando houver erro de autenticação

errors

String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example

1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

404

Se o evento não existir

errors

String

Mensagem de erro

Ex: Não foi possível encontrar o evento, verifique o Workspace ID e idempotency_key e tente novamente

Example

1
2
3
{
  "errors": "Não foi possível encontrar o evento, verifique o Workspace ID e idempotency_key e tente novamente"
}

422

Se houver inconsistência nos dados informados

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors

String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example

1
2
3
{
  "errors": "Internal Server Error, please try again later."
}

Back

Cria um evento de billing baseado nos parametros do body.

Forward

Lista eventos com falhas nas últimas 23 horas.